Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve forecast trial docs #224

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

dplarson
Copy link
Contributor

@dplarson dplarson commented Jan 24, 2023

Improve the forecast trial documentation by adding new examples and revised discussions. The goal is not to provide a step-by-step guide, but rather to inform users about the core concepts involved in running a forecast trial using the Arbiter. The examples and discussion in this PR reflect both (1) lessons learned from past forecast trials (using the Arbiter) and (2) feedback from industry stakeholders (forecast users and forecast providers).

This PR is meant to resolve issue #223

Revise the forecast trial section to add more specific, "real-world"
details such as it being an electric utility wanting to do the trial and
the focus being on forecasting power generation from the utility's fleet
of solar PV power plants.

Also add additional examples that build off of the first example. This
way readers can focus on the differences in the examples, rather than
having to re-read a copy&paste version of Example 1 and try to figure
out what the differences are.
Copy link
Member

@awig awig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and reproduced locally. I did make a few changes @dplarson for your consideration.

@dplarson
Copy link
Contributor Author

I'm generally okay with the changes, but will make a couple minor revisions before submitting (e.g., say "persistence forecast" instead of "persistence" in case some readers are not familiar with persistence forecast methods).

@cwhanse
Copy link
Contributor

cwhanse commented Jan 30, 2023

I'm thumbs down on editing the Use Cases as if they are supposed to be user instructions. The Use Cases were meant to guide development, not to provide a step-by-step how-to. I think they should be left static.

If we want a User Guide, let's make that and put it here: https://forecastarbiter.epri.com/documentation/

@awig
Copy link
Member

awig commented Jan 31, 2023

That's a good point and agree that we should have a User's Guide, that actually goes through code examples. I know David already developed some example code for the previous trials - basically i think we can just use those.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants